<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>glutes: RGlutAnimation Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">glutes
   &#160;<span id="projectnumber">2</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('class_r_glut_animation.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">RGlutAnimation Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="RGlutAnimation" -->
<p>Base class for animation(or effects) framework.  
 <a href="class_r_glut_animation.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="rglutanimation_8h_source.html">rglutanimation.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for RGlutAnimation:</div>
<div class="dyncontent">
<div class="center"><img src="class_r_glut_animation__inherit__graph.png" border="0" usemap="#_r_glut_animation_inherit__map" alt="Inheritance graph"/></div>
<map name="_r_glut_animation_inherit__map" id="_r_glut_animation_inherit__map">
<area shape="rect" id="node3" href="class_r_glut_window_state_animation.html" title="Animation implementation for window properties." alt="" coords="5,425,261,663"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for RGlutAnimation:</div>
<div class="dyncontent">
<div class="center"><img src="class_r_glut_animation__coll__graph.png" border="0" usemap="#_r_glut_animation_coll__map" alt="Collaboration graph"/></div>
<map name="_r_glut_animation_coll__map" id="_r_glut_animation_coll__map">
<area shape="rect" id="node2" href="class_r_glut_animation_listner.html" title="{RGlutAnimationListner\n||+ ~RGlutAnimationListner()\l+ started()\l+ stopped()\l}" alt="" coords="5,43,224,170"/><area shape="rect" id="node4" href="class_r_glut_time.html" title="Time class implementation for different platform." alt="" coords="248,34,384,179"/><area shape="rect" id="node6" href="class_r_glut_timer.html" title="Timer class implementation." alt="" coords="408,6,547,207"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_r_glut_animation-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_glut_animation.html#ab40a7db7d3612860238325d14e007d8a">duration</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_glut_animation.html#a729d2ddcc9fa65d45785d92ef3441c09">setDuration</a> (int d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_glut_animation.html#ad157fbd5f7703a3225205c693c822204">interval</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_glut_animation.html#a64d299a1913e7d89d96ce2a72cd028d2">setInterval</a> (int interval)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_glut_animation.html#ab2ef34163f537ce5c3a9bdd91bf59e4e">start</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_glut_animation.html#ab623f1e5285dea646a90e169d733254d">stop</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_glut_animation.html#ae923904f5dd2a6acc6a5d2fa472446c4">setListner</a> (<a class="el" href="class_r_glut_animation_listner.html">RGlutAnimationListner</a> *l)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_glut_animation.html#a9152de4d2592d10c6d9e9c4b53e45e7c">update</a> (int time)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf1ab2d5110f40987bb9e620e7b82cdd"></a><!-- doxytag: member="RGlutAnimation::timeExpired" ref="adf1ab2d5110f40987bb9e620e7b82cdd" args="()" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>timeExpired</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5c5a96340947128dd1ee99742c1e9a4"></a><!-- doxytag: member="RGlutAnimation::mState" ref="ae5c5a96340947128dd1ee99742c1e9a4" args="" -->
State&#160;</td><td class="memItemRight" valign="bottom"><b>mState</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5351dae8991c5c32e43198d905f4a8b4"></a><!-- doxytag: member="RGlutAnimation::mTimer" ref="a5351dae8991c5c32e43198d905f4a8b4" args="" -->
<a class="el" href="class_r_glut_timer.html">RGlutTimer</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>mTimer</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73f66a29d46532f898b5bce1495a3751"></a><!-- doxytag: member="RGlutAnimation::mDuration" ref="a73f66a29d46532f898b5bce1495a3751" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>mDuration</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af39adf43c6e7b301f8cd7a15a74a9e93"></a><!-- doxytag: member="RGlutAnimation::mTime" ref="af39adf43c6e7b301f8cd7a15a74a9e93" args="" -->
<a class="el" href="class_r_glut_time.html">RGlutTime</a>&#160;</td><td class="memItemRight" valign="bottom"><b>mTime</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86030a35a472c24538d914d0e7a4415c"></a><!-- doxytag: member="RGlutAnimation::mInterval" ref="a86030a35a472c24538d914d0e7a4415c" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>mInterval</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae355d709c9a5ff09808e0a23be169fcf"></a><!-- doxytag: member="RGlutAnimation::mListner" ref="ae355d709c9a5ff09808e0a23be169fcf" args="" -->
<a class="el" href="class_r_glut_animation_listner.html">RGlutAnimationListner</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>mListner</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for animation(or effects) framework. </p>
<p>To implement an Animation class derive from this class and implement void <a class="el" href="class_r_glut_animation.html#a9152de4d2592d10c6d9e9c4b53e45e7c">update(int)</a> method.<br/>
 For Example: </p>
<div class="fragment"><pre class="fragment">        <span class="keyword">class </span>MyAnimation: <span class="keyword">public</span> <a class="code" href="class_r_glut_animation.html" title="Base class for animation(or effects) framework.">RGlutAnimation</a>
        {
        <span class="keyword">public</span>:
            <span class="keywordtype">void</span> <a class="code" href="class_r_glut_animation.html#a9152de4d2592d10c6d9e9c4b53e45e7c">update</a>(<span class="keywordtype">int</span>)
            {
            <span class="comment">// do the updation of the state here</span>
            }
        };
</pre></div> </div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab40a7db7d3612860238325d14e007d8a"></a><!-- doxytag: member="RGlutAnimation::duration" ref="ab40a7db7d3612860238325d14e007d8a" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RGlutAnimation::duration </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Retrieves the duration </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The animation duration </dd></dl>

</div>
</div>
<a class="anchor" id="ad157fbd5f7703a3225205c693c822204"></a><!-- doxytag: member="RGlutAnimation::interval" ref="ad157fbd5f7703a3225205c693c822204" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RGlutAnimation::interval </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Retrieves the interval </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The animation interval </dd></dl>

</div>
</div>
<a class="anchor" id="a729d2ddcc9fa65d45785d92ef3441c09"></a><!-- doxytag: member="RGlutAnimation::setDuration" ref="a729d2ddcc9fa65d45785d92ef3441c09" args="(int d)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RGlutAnimation::setDuration </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>d</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the duration </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">d</td><td>The animation duration to set. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a64d299a1913e7d89d96ce2a72cd028d2"></a><!-- doxytag: member="RGlutAnimation::setInterval" ref="a64d299a1913e7d89d96ce2a72cd028d2" args="(int interval)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RGlutAnimation::setInterval </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>interval</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the interval </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">interval</td><td>The animation interval to set. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ae923904f5dd2a6acc6a5d2fa472446c4"></a><!-- doxytag: member="RGlutAnimation::setListner" ref="ae923904f5dd2a6acc6a5d2fa472446c4" args="(RGlutAnimationListner *l)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RGlutAnimation::setListner </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_r_glut_animation_listner.html">RGlutAnimationListner</a> *&#160;</td>
          <td class="paramname"><em>l</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the animation listner </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">l</td><td>This listner object. Ownership is with the caller. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ab2ef34163f537ce5c3a9bdd91bf59e4e"></a><!-- doxytag: member="RGlutAnimation::start" ref="ab2ef34163f537ce5c3a9bdd91bf59e4e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RGlutAnimation::start </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This method will be called to start the animation </p>

</div>
</div>
<a class="anchor" id="ab623f1e5285dea646a90e169d733254d"></a><!-- doxytag: member="RGlutAnimation::stop" ref="ab623f1e5285dea646a90e169d733254d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RGlutAnimation::stop </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This method will be called to stop the animation </p>

</div>
</div>
<a class="anchor" id="a9152de4d2592d10c6d9e9c4b53e45e7c"></a><!-- doxytag: member="RGlutAnimation::update" ref="a9152de4d2592d10c6d9e9c4b53e45e7c" args="(int time)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void RGlutAnimation::update </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>time</em></td><td>)</td>
          <td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Update function will be called when the timer expires. </p>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="class_r_glut_animation.html">RGlutAnimation</a>      </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">Generated on Tue Nov 15 2011 10:57:42 for glutes by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
